Add an extension for UEFI references (not DTSPEC anymore) #109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vstehle
changed the title
|
Fixed typo breaking all the links. |
vstehle
force-pushed
the
uefi-links
branch
3 times, most recently
from
110da55 to
17e201a
Compare
|
Rebased, added python typing and added more details to the README. |
|
Fixed index line endings. |
vstehle
force-pushed
the
uefi-links
branch
2 times, most recently
from
6470d99 to
b9d82b5
Compare
vstehle
force-pushed
the
uefi-links
branch
2 times, most recently
from
80b9483 to
90ad45e
Compare
|
Reviving this pull request a bit:
|
vstehle
changed the title
vstehle
force-pushed
the
uefi-links
branch
2 times, most recently
from
df183dc to
68e98bc
Compare
xypron
suggested changes
Feb 26, 2024
Add an extension python script to supplement our references to the UEFI specification with corresponding section title and web-page hyperlink. Hook the new extension into the `conf.py' sphinx configuration. We keep the index under version control for caching, and we have a python script to re-generate it. Convert all the UEFI references to use the new extension and adapt a bit for readability when necessary. Mention the extension in the README. While at it, tell git to ignore the folders produced by python when running the extension. Signed-off-by: Vincent Stehlé <[email protected]>
|
Thanks @xypron for reviewing this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here is an extension to help with our numerous references to the UEFI specification.
I converted all the UEFI references to use the new extension and adapted a bit for readability when necessary.
Let me know how you like the result.
Update: added Devicetree references, too.